API

Finance APIs

GET finance/fixed-assets/{fixedAssetId}

Fixed asset details for provided identifier

HTTP method GET
URI https://api.rambase.net/finance/fixed-assets/{fixedAssetId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {fixedAssetId} Fixed asset identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 504, version 12

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<FixedAsset>
2
     <FixedAssetId
FixedAssetId

Fixed asset identifier

>{Integer}</FixedAssetId>
3
     <Status
Status

Status of fixed asset

Possible domain values can be found here

>{Integer}</Status>
4
     <Name
Name

Name of fixed asset

>{String}</Name>
5
     <Description
Description

Description of fixed asset

>{String}</Description>
6
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
7
     <HasDepreciations
HasDepreciations

Indicates if depreciations exists for the fixed asset or not

>{Boolean}</HasDepreciations>
8
     <Type
Type

Type of fixed asset.

Possible domain values can be found here

>{String}</Type>
9
     <Investment
Investment

Investment details for the fixed asset

>
10
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
11
          <Amount
Amount

Represents the current investment amount of the fixed asset.

>{Decimal}</Amount>
12
          <InitialAmount
InitialAmount

Represents the Initial investment amount of the fixed asset before adjustments.

This field is greyed out because it is an expandable field. You have to add $expand=Investment.InitialAmount in your request URI to get this field

>{Decimal}</InitialAmount>
13
          <Period
Period

Investment period of the fixed asset

>{Integer}</Period>
14
          <Reference
Reference

Investment reference of fixed asset.

>{String}</Reference>
15
          <GeneralLedgerAccount>
16
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
17
               <Name
Name

Name of general ledger account

This field is greyed out because it is an expandable field. You have to add $expand=Investment.GeneralLedgerAccount.Name in your request URI to get this field

>{String}</Name>
18
               <AccountNumber
AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>
19
               <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
20
          </GeneralLedgerAccount>
21
          <Department
Department

The department related to the fixed asset. One of the system/fixed account dimensions.

>
22
               <DepartmentId
DepartmentId

Department identifier

>{Integer}</DepartmentId>
23
               <Name
Name

Name of department

This field is greyed out because it is an expandable field. You have to add $expand=Investment.Department.Name in your request URI to get this field

>{String}</Name>
24
               <DepartmentLink
DepartmentLink

Finance department reference

>{String}</DepartmentLink>
25
          </Department>
26
          <FinanceProject
FinanceProject

The finance project related to the fixed asset. One of the system/fixed account dimensions.

>
27
               <FinanceProjectId
FinanceProjectId

Finance project identifier

>{Integer}</FinanceProjectId>
28
               <Name
Name

Name of finance project

This field is greyed out because it is an expandable field. You have to add $expand=Investment.FinanceProject.Name in your request URI to get this field

>{String}</Name>
29
               <FinanceProjectLink
FinanceProjectLink

Finance project reference

>{String}</FinanceProjectLink>
30
          </FinanceProject>
31
          <Asset
Asset

The asset related to the fixed asset. One of the system/fixed account dimensions.

>
32
               <AssetId
AssetId

Asset identifier

>{Integer}</AssetId>
33
               <Name
Name

Name of asset

This field is greyed out because it is an expandable field. You have to add $expand=Investment.Asset.Name in your request URI to get this field

>{String}</Name>
34
               <AssetLink
AssetLink

Asset reference

>{String}</AssetLink>
35
          </Asset>
36
     </Investment>
37
     <Depreciation
Depreciation

Depreciation details for the fixed asset

>
38
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
39
          <DepreciatedAmount
DepreciatedAmount

Represents the depreciated amount of the fixed asset.

>{Decimal}</DepreciatedAmount>
40
          <DepreciatedPercentage
DepreciatedPercentage

Represents the depreciated percentage of the fixed asset.

>{Decimal}</DepreciatedPercentage>
41
          <FirstPeriod
FirstPeriod

First depreciation period of the fixed asset

>{Integer}</FirstPeriod>
42
          <LastPeriod
LastPeriod

Last depreciation period of the fixed asset

>{Integer}</LastPeriod>
43
          <Rule>
44
               <DepreciationRuleId
DepreciationRuleId

Depreciation rule identifier

>{Integer}</DepreciationRuleId>
45
               <Name
Name

Name of depreciation rule

>{String}</Name>
46
               <DepreciationPeriods
DepreciationPeriods

Count of periods of depreciation rule

>{Integer}</DepreciationPeriods>
47
               <BalanceAccount>
48
                    <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
49
                    <Name
Name

Name of general ledger account

This field is greyed out because it is an expandable field. You have to add $expand=Depreciation.Rule.BalanceAccount.Name in your request URI to get this field

>{String}</Name>
50
                    <AccountNumber
AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>
51
                    <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
52
               </BalanceAccount>
53
               <DepreciationAccount>
54
                    <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
55
                    <Name
Name

Name of general ledger account

This field is greyed out because it is an expandable field. You have to add $expand=Depreciation.Rule.DepreciationAccount.Name in your request URI to get this field

>{String}</Name>
56
                    <AccountNumber
AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>
57
                    <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
58
               </DepreciationAccount>
59
               <DepreciationRuleLink
DepreciationRuleLink

Depreciation rule reference

>{String}</DepreciationRuleLink>
60
          </Rule>
61
     </Depreciation>
62
     <Balance>
63
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
64
          <Amount
Amount

Balance of fixed asset

>{Decimal}</Amount>
65
     </Balance>
66
</FixedAsset>
1
{
2
     "fixedAsset": {
3
          "fixedAssetId
FixedAssetId

Fixed asset identifier

": "{Integer}",
4
          "status
Status

Status of fixed asset

Possible domain values can be found here

": "{Integer}",
5
          "name
Name

Name of fixed asset

": "{String}",
6
          "description
Description

Description of fixed asset

": "{String}",
7
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
8
          "hasDepreciations
HasDepreciations

Indicates if depreciations exists for the fixed asset or not

": "{Boolean}",
9
          "type
Type

Type of fixed asset.

Possible domain values can be found here

": "{String}",
10
          "investment
Investment

Investment details for the fixed asset

": {
11
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
12
               "amount
Amount

Represents the current investment amount of the fixed asset.

": "{Decimal}",
13
               "initialAmount
InitialAmount

Represents the Initial investment amount of the fixed asset before adjustments.

This field is greyed out because it is an expandable field. You have to add $expand=Investment.InitialAmount in your request URI to get this field

": "{Decimal}",
14
               "period
Period

Investment period of the fixed asset

": "{Integer}",
15
               "reference
Reference

Investment reference of fixed asset.

": "{String}",
16
               "generalLedgerAccount": {
17
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
18
                    "name
Name

Name of general ledger account

This field is greyed out because it is an expandable field. You have to add $expand=Investment.GeneralLedgerAccount.Name in your request URI to get this field

": "{String}",
19
                    "accountNumber
AccountNumber

The account number of the general ledger account

": "{String}",
20
                    "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
21
               },
22
               "department
Department

The department related to the fixed asset. One of the system/fixed account dimensions.

": {
23
                    "departmentId
DepartmentId

Department identifier

": "{Integer}",
24
                    "name
Name

Name of department

This field is greyed out because it is an expandable field. You have to add $expand=Investment.Department.Name in your request URI to get this field

": "{String}",
25
                    "departmentLink
DepartmentLink

Finance department reference

": "{String}"
26
               },
27
               "financeProject
FinanceProject

The finance project related to the fixed asset. One of the system/fixed account dimensions.

": {
28
                    "financeProjectId
FinanceProjectId

Finance project identifier

": "{Integer}",
29
                    "name
Name

Name of finance project

This field is greyed out because it is an expandable field. You have to add $expand=Investment.FinanceProject.Name in your request URI to get this field

": "{String}",
30
                    "financeProjectLink
FinanceProjectLink

Finance project reference

": "{String}"
31
               },
32
               "asset
Asset

The asset related to the fixed asset. One of the system/fixed account dimensions.

": {
33
                    "assetId
AssetId

Asset identifier

": "{Integer}",
34
                    "name
Name

Name of asset

This field is greyed out because it is an expandable field. You have to add $expand=Investment.Asset.Name in your request URI to get this field

": "{String}",
35
                    "assetLink
AssetLink

Asset reference

": "{String}"
36
               }
37
          },
38
          "depreciation
Depreciation

Depreciation details for the fixed asset

": {
39
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
40
               "depreciatedAmount
DepreciatedAmount

Represents the depreciated amount of the fixed asset.

": "{Decimal}",
41
               "depreciatedPercentage
DepreciatedPercentage

Represents the depreciated percentage of the fixed asset.

": "{Decimal}",
42
               "firstPeriod
FirstPeriod

First depreciation period of the fixed asset

": "{Integer}",
43
               "lastPeriod
LastPeriod

Last depreciation period of the fixed asset

": "{Integer}",
44
               "rule": {
45
                    "depreciationRuleId
DepreciationRuleId

Depreciation rule identifier

": "{Integer}",
46
                    "name
Name

Name of depreciation rule

": "{String}",
47
                    "depreciationPeriods
DepreciationPeriods

Count of periods of depreciation rule

": "{Integer}",
48
                    "balanceAccount": {
49
                         "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
50
                         "name
Name

Name of general ledger account

This field is greyed out because it is an expandable field. You have to add $expand=Depreciation.Rule.BalanceAccount.Name in your request URI to get this field

": "{String}",
51
                         "accountNumber
AccountNumber

The account number of the general ledger account

": "{String}",
52
                         "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
53
                    },
54
                    "depreciationAccount": {
55
                         "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
56
                         "name
Name

Name of general ledger account

This field is greyed out because it is an expandable field. You have to add $expand=Depreciation.Rule.DepreciationAccount.Name in your request URI to get this field

": "{String}",
57
                         "accountNumber
AccountNumber

The account number of the general ledger account

": "{String}",
58
                         "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
59
                    },
60
                    "depreciationRuleLink
DepreciationRuleLink

Depreciation rule reference

": "{String}"
61
               }
62
          },
63
          "balance": {
64
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
65
               "amount
Amount

Balance of fixed asset

": "{Decimal}"
66
          }
67
     }
68
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100170 HTTP 404 Asset not found